home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / gaim / eventloop.h < prev    next >
C/C++ Source or Header  |  2005-10-18  |  4KB  |  150 lines
  1. /**
  2.  * @file eventloop.h Gaim Event Loop API
  3.  * @ingroup core
  4.  *
  5.  * gaim
  6.  *
  7.  * Gaim is the legal property of its developers, whose names are too numerous
  8.  * to list here.  Please refer to the COPYRIGHT file distributed with this
  9.  * source distribution.
  10.  *
  11.  * This program is free software; you can redistribute it and/or modify
  12.  * it under the terms of the GNU General Public License as published by
  13.  * the Free Software Foundation; either version 2 of the License, or
  14.  * (at your option) any later version.
  15.  *
  16.  * This program is distributed in the hope that it will be useful,
  17.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19.  * GNU General Public License for more details.
  20.  *
  21.  * You should have received a copy of the GNU General Public License
  22.  * along with this program; if not, write to the Free Software
  23.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24.  */
  25. #ifndef _GAIM_EVENTLOOP_H_
  26. #define _GAIM_EVENTLOOP_H_
  27.  
  28. #include <glib.h>
  29.  
  30. #ifdef __cplusplus
  31. extern "C" {
  32. #endif
  33.  
  34. /**
  35.  * An input condition.
  36.  */
  37. typedef enum
  38. {
  39.     GAIM_INPUT_READ  = 1 << 0,  /**< A read condition.  */
  40.     GAIM_INPUT_WRITE = 1 << 1   /**< A write condition. */
  41.  
  42. } GaimInputCondition;
  43.  
  44. typedef void (*GaimInputFunction)(gpointer, gint, GaimInputCondition);
  45.  
  46. typedef struct _GaimEventLoopUiOps GaimEventLoopUiOps;
  47.  
  48. struct _GaimEventLoopUiOps
  49. {
  50.     /**
  51.      * Creates a callback timer.
  52.      * @see g_timeout_add, gaim_timeout_add
  53.      **/
  54.     guint (*timeout_add)(guint interval, GSourceFunc function, gpointer data);
  55.  
  56.     /**
  57.      * Removes a callback timer.
  58.      * @see gaim_timeout_remove, g_source_remove
  59.      */
  60.     guint (*timeout_remove)(guint handle);
  61.  
  62.     /**
  63.      * Adds an input handler.
  64.      * @see gaim_input_add, g_io_add_watch_full
  65.      */
  66.     guint (*input_add)(int fd, GaimInputCondition cond,
  67.                        GaimInputFunction func, gpointer user_data);
  68.  
  69.     /**
  70.      * Removes an input handler.
  71.      * @see gaim_input_remove, g_source_remove
  72.      */
  73.     guint (*input_remove)(guint handle);
  74. };
  75.  
  76. /**************************************************************************/
  77. /** @name Event Loop API                                                  */
  78. /**************************************************************************/
  79. /*@{*/
  80. /**
  81.  * Creates a callback timer.
  82.  * The timer will repeat until the function returns <tt>FALSE</tt>. The
  83.  * first call will be at the end of the first interval.
  84.  * @param interval    The time between calls of the function, in
  85.  *                    milliseconds.
  86.  * @param function    The function to call.
  87.  * @param data        data to pass to <tt>function</tt>.
  88.  **/
  89. guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data);
  90.  
  91. /**
  92.  * Removes a timeout handler.
  93.  *
  94.  * @param handle The handle, as returned by gaim_timeout_add.
  95.  *
  96.  * @return Something.
  97.  */
  98. guint gaim_timeout_remove(guint handle);
  99.  
  100. /**
  101.  * Adds an input handler.
  102.  *
  103.  * @param fd        The input file descriptor.
  104.  * @param cond      The condition type.
  105.  * @param func      The callback function for data.
  106.  * @param user_data User-specified data.
  107.  *
  108.  * @return The resulting handle.
  109.  * @see g_io_add_watch_full
  110.  */
  111. guint gaim_input_add(int fd, GaimInputCondition cond,
  112.                      GaimInputFunction func, gpointer user_data);
  113.  
  114. /**
  115.  * Removes an input handler.
  116.  *
  117.  * @param handle The handle of the input handler. Note that this is the return
  118.  * value from gaim_input_add, <i>not</i> the file descriptor.
  119.  */
  120. guint gaim_input_remove(guint handle);
  121.  
  122. /*@}*/
  123.  
  124.  
  125. /**************************************************************************/
  126. /** @name UI Registration Functions                                       */
  127. /**************************************************************************/
  128. /*@{*/
  129. /**
  130.  * Sets the UI operations structure to be used for accounts.
  131.  *
  132.  * @param ops The UI operations structure.
  133.  */
  134. void gaim_eventloop_set_ui_ops(GaimEventLoopUiOps *ops);
  135.  
  136. /**
  137.  * Returns the UI operations structure used for accounts.
  138.  *
  139.  * @return The UI operations structure in use.
  140.  */
  141. GaimEventLoopUiOps *gaim_eventloop_get_ui_ops(void);
  142.  
  143. /*@}*/
  144.  
  145. #ifdef __cplusplus
  146. }
  147. #endif
  148.  
  149. #endif /* _GAIM_EVENTLOOP_H_ */
  150.